CygNet Studio > Using CygNet Studio Tools and Controls > CygNet Event Summary Control > Properties, Events, and Methods > Methods

CygNet Event Summary Control – Methods

The following table lists and describes methods of the CygNet Event Summary Control. Methods are accessed using the control's script editor.

Method Description

AboutBox

The AboutBox method displays an About dialog box for the control.

Cancel

The Cancel method closes an object and TheView.

ClearAudFilters

The ClearFilters method clears all AUD rules and filters from the control.

ClearElsAlarmFilters

The ClearFilters method clears all ELSALM rules and filters from the control.

ClearElsEventFilters

The ClearFilters method clears all ELS Event rules and filters from the control.

DisplayNextRecords

The DisplayNextRecords method shows the next available record.

EnableAllAudFilters

The EnableAllAudFilters method uses all AUD service rules and filters

EnableAllElsAlarmFilters

The EnableAllElsAlarmFilters method uses all ELSALM service rules and filters.

EnableAllElsEventFilters

The EnableAllElsEventFilters method uses all ELS service rules and filters.

EnableAudFilter

The EnableAudFilter method uses the specified AUD service filter.

EnableElsAlarmFilter

The EnableElsAlarmFilter method uses the specified ELSALM service filter.

EnableElsEventFilter

The EnableElsEventFilter method uses the specified ELS service filter.

Export

The Export method exports the contents of the grid to a temporary CSV file and opens the file with the default spreadsheet viewer for the user to view and save to disk.

GetAudError

The GetAudError method retrieves an error list from the AUD service.

GetAudFilterNames

 

GetColumnConfiguration

 

GetElsAlarmError

The GetElsAlarmError method retrieves an error list from the ELSALM service.

GetElsAlarmFilterNames

The GetElsAlarmFilterNames method retrieves filter names from the ELSALM service.

GetElsEventError

The GetElsEventError method retrieves an error list from the ELS service.

GetElsEventFilterNames

The GetElsEventFilterNames method retrieves filter names from the ELS service.

GetEventSummaryCustomAttribute

The GetEventSummaryCustomAttribute method retrieves custom event attributes.

GetMaxCacheSize

The GetMaxCacheSize method retrieves the value for maximum cache size of the specified service (AUD, ELS, or ELSALM)

Options are integers:

    1 - AUD service cache
    2 - ELS service cache
    3 - ELSALM service cache

The method will fail (return "-1") if an option other than 1, 2, or 3 is entered.

When successful, returned values are between 20,000 and 10,000,000 records.

GetMostRecentFirst

The GetMostRecentFirst method retrieves the most recent record first.

GetNumRecords

The GetNumRecords method retrieves only numerical records.

GetPropertyValue

The GetPropertyValue method retrieves the value of the selected property.

Example

Dim Handel,i

Handel = CxEventCtrl1.GetRowHandles

For i=0 To ubound(Handel)

msgbox "Handle: "& Handel(i)

msgbox "Here are details: "& CxEventCtrl1.GetPropertyValue (Handel(i), "eventtime")

Next

GetRowFacility

The GetRowFacility method retrieves the facility for the selected row.

GetRowHandles

The GetRowHandles method retrieves the handles for the selected row.

Example

Dim Handel,i

Handel = CxEventCtrl1.GetRowHandles

For i=0 To ubound(Handel)

msgbox "Handle: "& Handel(i)

msgbox "Here are details: "& CxEventCtrl1.GetPropertyValue (Handel(i), "eventtime")

Next

GetRowPoint

The GetRowPoint method retrieves the point for the selected row.

HasNextElsAlarmRecords

The HasNextElsAlarmRecords method displays whether or not there is a subsequent ELS alarm record after the currently selected record.

IsAudFilterEnabled

The IsAudFilterEnabled method displays whether or not AUD service filters are enabled.

IsElsAlarmFilterEnabled

The IsElsAlarmFilterEnabled method displays whether or not ELSALM service filters are enabled.

IsElsEventFilterEnabled

The IsElsEventFilterEnabled method displays whether or not ELS service filters are enabled.

Print

The Print method prints the contents of the control, grid, or viewer. When this method is called, the Print dialog box is shown to allow configuration.

Refresh

The Refresh method refreshes the contents of the control from the Current Value Service (CVS).

RefreshRow

The RefreshRow method refreshes the contents of the selected row.

RefreshSoft

 

RestoreInitialAudFilter

 

RestoreInitialElsAlarmFilter

 

RestoreInitialElsEventFilter

 

RowFacility

 

RowHasPoint

The RowHasPoint method displays whether or not the selected record row has a corresponding Point configured in the system.

SetEventSummaryCustomAttribute

The GetEventSummaryCustomAttribute method sets custom event attributes.

SetMaxCacheSize

The SetMaxCacheSize method sets the maximum value for the cache size for the specified service (AUD, ELS, or ELSALM)

Options are integers:

    1 - AUD service cache
    2 - ELS service cache
    3 - ELSALM service cache

The method will fail (return "False") if an option other than 1, 2, or 3 is entered.

Possible values are between 20,000 and 10,000,000 records. If the specified cache is out of range, the method will fail (return "False"). If the method is not used, the default value is 20,000 records.

SetMostRecentFirst

The GetMostRecentFirst method sets the most recent record.

SetRowReadOnlyState

 

ShowFilters

 

ShowProperties

The ShowProperties method displays the properties for the currently selected record.

Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.